Facility Navigation Bar Tool

Facility Navigation Bar Tool – Methods

The following table lists and describes methods of the Facility Navigation Bar Tool. Methods are accessed using the control's script editor. See FacNavBar Methods for more information about using these methods in script.

Note: If a property or method in the script editor has two forms with the same name, one form exists for legacy support and the other form is current. When possible, use the current form. To select the current form, append .X. to the name of the object to which the property or method applies, and then enter the property or method name. For instance, enter MyObject.X.MyProperty. If a property or method in the script editor has only one form, the X method might or might not apply. The column in the table below indicates whether or not a property or method is accessible using the X method.

Method		Description
AboutBox	Yes	The AboutBox method displays an About dialog box for the control.
AlarmAcknowledge	No	The AlarmAcknowledge method acknowledges an alarm.
CanNavNext	Yes	The CanNavNext method specifies whether the next target item (facility or node) can be selected.
CanNavPrev	Yes	The CanNavPrev method specifies whether the previous target item (facility or node) can be selected.
CanSelNext	Yes	The CanSelNext method returns True if the next item (facility attribute value or node) for the specified level can be selected. Otherwise returns False.
CanSelPrev	Yes	The CanSelPrev method returns True if the previous item (facility attribute value or node) for the specified level can be selected. Otherwise returns False.
ClearMenu	No	The ClearMenu method clears all custom items from the context menu. Syntax `ClearMenu()` Parameters This method takes no parameters. Return Values This method returns no values.
EnableAllInitialFilterRules	Yes	The EnableAllInitialFilterRules method enables or disables all rules and vectors for the initial filter.
EnableInitialFilterRule	Yes	The EnableInitialFilterRule method enables or disables a rule or vector of rules by name for the initial filter.
FacilityConfig	No
GetAllTargetFacTags	Yes	The GetAllTargetFacTags method returns an array of all target facility tags.
GetDlgCtrlID	No	The GetDlgCtrlID method returns the numeric resource identifier of the control within TheView.
GetFacNavBarCustomAttribute	Yes	The GetFacNavBarCustomAttribute method returns the value of a facility navigation bar custom attribute.
GetGroup	Yes	The GetGroup method returns the object group to which an object belongs, and returns null if the object does not belong to a group. The GroupID property returns the GroupID. Calling GetGroup is equivalent to calling TheView GetGroupByID and passing the value of the object’s GroupID property, and is provided for convenience.
GetInitialFilterRuleNames	Yes	The GetInitialFilterRuleNames method returns the names of enabled and disabled rules for the initial filter.
GetSelectedTargetFacTag	Yes	The GetSelecedTargetFacTag method returns the facility tag corresponding to the target level combo box selection.
GetTargetFacilityAttrValues	Yes	The GetTargetFacilityAttrValues method returns the specified attribute value for all target facilities.
HistoryAlarms	No	The HistoryAlarms method calls the Alarm History dialog box, which shows the alarm history of an individual alarm, and provides options for showing only particular types of alarm events. See Alarm History for more information.
HistoryValues	No	The HistoryValues method calls the History Values dialog box, which shows all the history records for a given point, including additional information if the history name came from the PNT. See History Records for more information.
IsSelected	No	The IsSelected method indicates if the tool or control is selected. Can be used with [ContextMenuAutoSelect].
LayerName	No	The LayerName method gets the name of the layer on which the object resides.
Move	No	The Move method moves an object by the specified amount, relative to its current position.
NavNext	Yes	The NavNext method navigates to the next target facility or node. Returns the number of the lowest-level combo box whose selection changed. The EventOnSelChangeLevel event is triggered when NavNext is called.
NavPrev	Yes	The NavPrev method navigates to the previous target facility or node. Returns the number of the lowest-level combo box whose selection changed. The EventOnSelChangeLevel event is triggered when NavPrev is called.
NotifySelChange	No	The NotifySelChange method forces a complete refresh of the tool and any connected/affected objects. For example, when used with a Group Navigation Bar, NotifySelChange forces a filter change on a Group Navigation Bar to apply to an associated Group Grid object.
NotifySelChangeLevel	Yes
OnUpdate	No	The OnUpdate method updates the control to ensure that any property modifications have taken effect.
OnUpdateResize	No	The OnUpdateResize method updates the control to ensure that any modifications to its boundary have taken effect.
OnUpdateStyle	No	The OnUpdateStyle method updates the control to ensure that any modifications to its style properties have taken effect.
PersistRunTimeCfg	Yes	The PersistRunTimeConfig method saves the current control configuration snapshot to the run-time registry key.
PointConfigAlarmSettings	No
PointConfigAlarmSuppression	No
PointConfigAll	No
PointConfigComments	No
PointConfigQuestionable	No
RegisterPointForChangeNotice	No	The RegisterPointForChangeNotice method registers an unrelated point on a screen that may change its value. Used in conjunction with EventPointChange.
RefreshTargetData	Yes
RemoveMenuItem	No
Restart	Yes	For objects, the Restart method stops and restarts Run mode. For TheFrame/TheView, the Restart method restarts TheView with new site, service, and facility information, if applicable.
RestoreDesignTimeCfg	Yes	The RestoreDesignTimeConfig method reverts the control to its design-time configuration.
RestoreRunTimeCfg	Yes	The RestoreRunTimeConfig method reverts the control back to the last run-time configuration.
RunInitialize	No	The RunInitialize method runs the object’s EventInitialize event code.
RunPumpData	No	This method is not used.
Select	No	The Select method selects the tool or control. "True" to select, "false" to deselect. Can be used with [ContextMenuAutoSelect].
SelNext	Yes	The SelNext method selects the next item (facility attribute value or node) for the specified level. If Wrap is True, the selection wraps to the first item, if necessary. The EventOnSelChangeLevel event is triggered when SelNext is called.
SelPrev	Yes	The SelPrev method selects the previous item (facility attribute value or node) for the specified level. If Wrap is True, the selection wraps to the last item, if necessary. The EventOnSelChangeLevel event is triggered when SelPrev is called.
SelTargetFacility	Yes	The SelectTargetFacility method selects the item in the target combo box that corresponds to the specified facility tag.
SetFacNavBarCustomAttribute	Yes	The SelFacNavBarCustomAttribute method sets the value of a facility navigation bar custom attribute.
SetFocus	No	The SetFocus method sets the focus to the control.
SetMenuItem	No
SetSubMenuItem	No
ShowConfiguration	No
ShowCurrentValue	No
Start	Yes	The Start method configures the control and starts Run mode.
Stop	Yes	The Stop method stops Run mode.
TrendAddPoint	No
TrendRemovePoint	No
TrendSinglePoint	No
TrendSinglePointRollup	No
X	No	The X method returns an object that lists properties and methods specific to an ActiveX control. This method is only available for some ActiveX controls.

Method

Description

AboutBox

Yes

The AboutBox method displays an About dialog box for the control.

AlarmAcknowledge

The AlarmAcknowledge method acknowledges an alarm.

CanNavNext

Yes

The CanNavNext method specifies whether the next target item (facility or node) can be selected.

CanNavPrev

Yes

The CanNavPrev method specifies whether the previous target item (facility or node) can be selected.

CanSelNext

Yes

The CanSelNext method returns True if the next item (facility attribute value or node) for the specified level can be selected. Otherwise returns False.

CanSelPrev

Yes

The CanSelPrev method returns True if the previous item (facility attribute value or node) for the specified level can be selected. Otherwise returns False.

ClearMenu

The ClearMenu method clears all custom items from the context menu.

Syntax

ClearMenu()

Parameters

This method takes no parameters.

Return Values

This method returns no values.

EnableAllInitialFilterRules

Yes

The EnableAllInitialFilterRules method enables or disables all rules and vectors for the initial filter.

EnableInitialFilterRule

Yes

The EnableInitialFilterRule method enables or disables a rule or vector of rules by name for the initial filter.

FacilityConfig

GetAllTargetFacTags

Yes

The GetAllTargetFacTags method returns an array of all target facility tags.

GetDlgCtrlID

The GetDlgCtrlID method returns the numeric resource identifier of the control within TheView.

GetFacNavBarCustomAttribute

Yes

The GetFacNavBarCustomAttribute method returns the value of a facility navigation bar custom attribute.

GetGroup

Yes

The GetGroup method returns the object group to which an object belongs, and returns null if the object does not belong to a group. The GroupID property returns the GroupID. Calling GetGroup is equivalent to calling TheView GetGroupByID and passing the value of the object’s GroupID property, and is provided for convenience.

GetInitialFilterRuleNames

Yes

The GetInitialFilterRuleNames method returns the names of enabled and disabled rules for the initial filter.

GetSelectedTargetFacTag

Yes

The GetSelecedTargetFacTag method returns the facility tag corresponding to the target level combo box selection.

GetTargetFacilityAttrValues

Yes

The GetTargetFacilityAttrValues method returns the specified attribute value for all target facilities.

HistoryAlarms

The HistoryAlarms method calls the Alarm History dialog box, which shows the alarm history of an individual alarm, and provides options for showing only particular types of alarm events. See Alarm History for more information.

HistoryValues

The HistoryValues method calls the History Values dialog box, which shows all the history records for a given point, including additional information if the history name came from the PNT. See History Records for more information.

IsSelected

The IsSelected method indicates if the tool or control is selected. Can be used with [ContextMenuAutoSelect].

LayerName

The LayerName method gets the name of the layer on which the object resides.

Move

The Move method moves an object by the specified amount, relative to its current position.

NavNext

Yes

The NavNext method navigates to the next target facility or node. Returns the number of the lowest-level combo box whose selection changed. The EventOnSelChangeLevel event is triggered when NavNext is called.

NavPrev

Yes

The NavPrev method navigates to the previous target facility or node. Returns the number of the lowest-level combo box whose selection changed. The EventOnSelChangeLevel event is triggered when NavPrev is called.

NotifySelChange

The NotifySelChange method forces a complete refresh of the tool and any connected/affected objects. For example, when used with a Group Navigation Bar, NotifySelChange forces a filter change on a Group Navigation Bar to apply to an associated Group Grid object.

NotifySelChangeLevel

Yes

OnUpdate

The OnUpdate method updates the control to ensure that any property modifications have taken effect.

OnUpdateResize

The OnUpdateResize method updates the control to ensure that any modifications to its boundary have taken effect.

OnUpdateStyle

The OnUpdateStyle method updates the control to ensure that any modifications to its style properties have taken effect.

PersistRunTimeCfg

Yes

The PersistRunTimeConfig method saves the current control configuration snapshot to the run-time registry key.

PointConfigAlarmSettings

PointConfigAlarmSuppression

PointConfigAll

PointConfigComments

PointConfigQuestionable

RegisterPointForChangeNotice

The RegisterPointForChangeNotice method registers an unrelated point on a screen that may change its value. Used in conjunction with EventPointChange.

RefreshTargetData

Yes

RemoveMenuItem

Restart

Yes

For objects, the Restart method stops and restarts Run mode. For TheFrame/TheView, the Restart method restarts TheView with new site, service, and facility information, if applicable.

RestoreDesignTimeCfg

Yes

The RestoreDesignTimeConfig method reverts the control to its design-time configuration.

RestoreRunTimeCfg

Yes

The RestoreRunTimeConfig method reverts the control back to the last run-time configuration.

RunInitialize

The RunInitialize method runs the object’s EventInitialize event code.

RunPumpData

This method is not used.

Select

The Select method selects the tool or control. "True" to select, "false" to deselect. Can be used with [ContextMenuAutoSelect].

SelNext

Yes

The SelNext method selects the next item (facility attribute value or node) for the specified level. If Wrap is True, the selection wraps to the first item, if necessary. The EventOnSelChangeLevel event is triggered when SelNext is called.

SelPrev

Yes

The SelPrev method selects the previous item (facility attribute value or node) for the specified level. If Wrap is True, the selection wraps to the last item, if necessary. The EventOnSelChangeLevel event is triggered when SelPrev is called.

SelTargetFacility

Yes

The SelectTargetFacility method selects the item in the target combo box that corresponds to the specified facility tag.

SetFacNavBarCustomAttribute

Yes

The SelFacNavBarCustomAttribute method sets the value of a facility navigation bar custom attribute.

SetFocus

The SetFocus method sets the focus to the control.

SetMenuItem

SetSubMenuItem

ShowConfiguration

ShowCurrentValue

Start

Yes

The Start method configures the control and starts Run mode.

Stop

Yes

The Stop method stops Run mode.

TrendAddPoint

TrendRemovePoint

TrendSinglePoint

TrendSinglePointRollup

The X method returns an object that lists properties and methods specific to an ActiveX control. This method is only available for some ActiveX controls.